home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds / makedepend.man < prev    next >
Encoding:
Text File  |  1991-12-02  |  6.4 KB  |  146 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /sprite/src/attcmds/makedepend/RCS/makedepend.man,v 1.3 91/12/02 14:04:15 shirriff Exp $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS MAKEDEPEND cmds
  13. .BS
  14. .SH NAME
  15. makedepend \- Generate dependency list for make
  16. .SH SYNOPSIS
  17. \fBmakedepend\fR [\fIoptions\fR] \fIfile file ...\fR
  18. .SH OPTIONS
  19. .IP "\fB\-D \fIdef\fR" 20
  20. Define a macro.  This argument has the same meaning as the corresponding
  21. argument to \fBcc\fR.
  22. .IP "\fB\-f \fImakefile\fR" 20
  23. Use \fImakefile\fR as the makefile to modify.  If \fImakefile\fR
  24. is ``\-'', \fBmakedepend\fR will simply print dependency information
  25. on standard output.  \fIMakefile\fR defaults to \fBmakefile\fR if
  26. it exists, otherwise \fBMakefile\fR.
  27. .IP "\fB\-I \fIincludeDir\fR" 20
  28. Search for include files in \fIincludeDir\fR before looking in the
  29. default system directories.  If there are many \fB\-I\fR arguments,
  30. the directories are searched in the same order as the arguments.
  31. .IP "\fB\-m \fItm\fR" 20
  32. Use \fItm\fR as the target machine for generating dependencies.
  33. The target machine determines where \fBmakedepend\fR looks for
  34. machine-dependent header files (see below).  If this option is
  35. not specified, the target machine defaults to the value of the
  36. \fB$MACHINE\fR environment variable.
  37. .IP "\fB\-o \fIsuffix\fR" 20
  38. Use \fIsuffix\fR as the suffix for the ``object'' files listed in
  39. the output.  If this argument is not specified, the suffix defaults
  40. to \fB.o\fR.
  41. .IP "\fB\-p\fR" 20
  42. Output the full path name for each include file.  If this switch
  43. isn't specified, then only the include file name given in the
  44. \fB#include\fR statement is output.
  45. .IP "\fB\-s \fIstring\fR" 20
  46. If this switch is given, \fIstring\fR specifies the comment string
  47. that identifies the beginning of dependencies in the makefile.
  48. \fIString\fR must start with the comment character ``#''.
  49. .IP "\fB\-v\fR" 20
  50. Verbose mode.  For each file included by one of the \fIfile\fRs,
  51. output a sequence of comment lines that list the other include
  52. files included by that include file.
  53. .IP "\fB\-w \fIwidth\fR" 20
  54. Try to arrange for output lines not to contain more than \fIwidth\fR
  55. characters total.  If a single \fIfile\fR has multiple dependencies
  56. then they will be grouped onto a single line in the output file unless
  57. this grouping would cause the output line to exceed \fIwidth\fR characters
  58. in length.
  59. .BE
  60.  
  61. .SH DESCRIPTION
  62. .LP
  63. \fBMakedepend\fR is a program that generates dependency lines for
  64. makefiles.  It reads a collection of C source files given by the
  65. \fIfile\fR arguments and generates a collection of lines each
  66. having the form
  67. .DS
  68. \fBfile.o:\ \ \ x.h\ \ \ y.h\ \ \ /a/b/c.h\fR
  69. .DE
  70. .LP
  71. These dependency lines describe all of the include files used
  72. directly or indirectly in compiling each source \fIfile\fR.
  73. .LP
  74. \fBMakedepend\fR normally inserts the dependency lines into the
  75. file \fBmakefile\fR if it exists, or \fBMakefile\fR otherwise
  76. (see the \fB\-f\fR option for other alternatives).  To insert the
  77. dependencies in a makefile, \fBmakedepend\fR searches the makefile
  78. for a trigger line.  Usually the trigger line is
  79. .DS C
  80. \fB# DO NOT DELETE THIS LINE -- make depend depends on it.\fR
  81. .DE
  82. .LP
  83. but a different trigger string may be selected with the \fB\-s\fR
  84. switch.  \fBMakedepend\fR locates the trigger line, deletes all of
  85. the information after the trigger line, and replaces it with the
  86. dependency lines.  A backup copy of the original makefile is saved
  87. in \fImakefile\fB.bak~\fR, where \fImakefile\fR is the name of the
  88. original makefile.
  89. .LP
  90. \fBMakedepend\fR duplicates the actions of \fBcc\fR in determining
  91. which include files are required for each \fIfile\fR.  It normally
  92. checks for include files in the current directory, then in
  93. \fB/sprite/lib/include\fR, then in \fB/sprite/lib/include/\fItm\fB.md\fR
  94. (where \fItm\fR is the target machine being compiled for;  this is
  95. either the value of the \fB$MACHINE\fR environment variable or
  96. the value given in the \fB\-m\fR option).  If \fB\-I\fR options are
  97. given, then those directories are searched before the standard system
  98. directories.  \fBMakedepend\fR processes conditional compilation
  99. statements such as \fB#define\fR and \fB#ifdef\fR in a fashion similar
  100. to the C preprocessor in order to consider only the include files that
  101. would be processed by the C compiler.  You should pass the same \fB\-D\fR
  102. options to \fBmakedepend\fR that you would give to \fBcc\fR.
  103. .VS
  104. \fBMakedepend\fR can also deal with \fB#if\fR and \fB#elif\fR directive, 
  105. except that the
  106. only allowable expressions are \fBdefined(\fIfoo\fB)\fR and 
  107. \fB!defined(\fIfoo\fB)\fR. 
  108. Any
  109. other expression will evaluate to false.
  110. .VE
  111. .LP
  112. There are several options that control the formatting of the dependency
  113. lines.  Normally, the first field of each output line is \fIx\fB.o\fR,
  114. where \fIx\fR is one of the \fIfile\fR arguments with the \fB.c\fR or
  115. any other suffix stripped off.  However, the \fB\-o\fR option may be used
  116. to place a suffix other than \fB.o\fR in the output lines.  The \fB\-p\fR
  117. option controls how completely the include file names are specified in
  118. the output.  If \fB\-p\fR is given, then the complete path name of each
  119. header file is output.  If \fB-p\fR is not given, then
  120. only the name from the actual \fB#include\fR statement is output
  121. (e.g., \fBsys/file.h\fR instead of \fB/sprite/lib/include/sys/file.h\fR).
  122. This default is useful for Pmake, which manages its own include file
  123. search path.  Finally, the \fB\-w\fR switch may be used to control the
  124. length of the output lines, and the \fB\-v\fR switch causes extra
  125. information about nested includes to be output in the form of comment
  126. lines.
  127.  
  128. .SH "SEE ALSO"
  129. mkmf, pmake
  130.  
  131. .SH BUGS
  132. .VS
  133. .LP
  134. Can't handle arbitrary expressions following \fB#if\fR or \fB#elif\fR.
  135. .LP
  136. Makedepend's algorithm can cause problems in some cases.  It only parses
  137. each include file once and generates a list of dependencies for that file.
  138. However, if defines are set differently, it could be that an include file
  139. will depend on two different sets of files in two different invocations.
  140. In this case, makedepend will return the wrong dependencies for the second
  141. case.
  142. .VE
  143.  
  144. .SH KEYWORDS
  145. dependencies, include file, object file
  146.